home *** CD-ROM | disk | FTP | other *** search
/ c't freeware shareware 1997 / CT_SW_97.ISO / mac / Software / entwickl / macos / CLImax10.hqx / CLImax 1.0 / Quick Reference < prev    next >
Text File  |  1996-06-17  |  6KB  |  110 lines

  1. CLImax Quick Reference
  2. This program is $15 shareware.
  3.  
  4. Brief description
  5.  
  6. CLImax is an AppleScript client designed to bring a kind of command-line interface to the Macintosh.  It uses a TSM (read: “magic floating”) window as an interface, which is always the foremost window no matter which application you might be in.  A flip of a hotkey toggles the window's visibility, so you can execute quick AppleScript commands from anywhere!
  7.  
  8. No extra extensions or control panels are required; CLImax is entirely application-based. There are no system patches, and no need to restart to install it! And since CLImax doesn't care whether it's a normal application or not, you can run it as an invisible background-only (daemon) process and still get the interface.
  9.  
  10.  
  11.  
  12. The window
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23. The left half of the window contains the script, and after execution, the right half will contain the result.  The active scripting system (typically “AppleScript English”) is identified just above the script field. In the top right, the default target application and the front process are displayed.
  24.  
  25. Clicking on the balloon icon brings up a pop-up menu to select the target process — like an AppleScript “tell” statement — and clicking on the icon that looks like a pair of windows brings up a similar pop-up to switch between apps. Clicking on the names next to the icons advances forward through the list.  You can drag the divider to change the sizes of the script and result fields.
  26.  
  27. The default hotkey to hide and show the window is command-`.  (The ` character is a backtick, which is probably in the upper-left corner of your keyboard.)  This can be configured from the preferences box.
  28.  
  29.  
  30.  
  31. Running Scripts
  32.  
  33. To execute a script command, just type it in and hit return. When it finishes, the result will be displayed in the right half of the window.  If you need to enter a more complex script that uses multiple lines, command-return forces a carriage return without executing, as does the enter key.
  34.  
  35. Spinning arrows will appear in the window, next to the scripting system name, while the script is running.  When it’s done, the result will appear in the right-hand side of the window.
  36.  
  37. At any time while a script is executing, you can press command-period (-.) to cancel.  You may need to hold it down until an event gets through.
  38.  
  39. Setting the default target
  40.  
  41. Command-tab sets the default [AppleScript] target to the next application in the list, and command-shift-tab sets it to the previous application in the list.  (This does the equivalent of an AppleScript “tell”, without the hassle... that’s what the balloon icon is supposed to suggest.)
  42.  
  43. Control-tab switches the target to whichever application is frontmost.
  44.  
  45. Option-tab toggles between talking to the Finder and to CLImax.
  46.  
  47. Command History
  48.  
  49. Option-up and option-down activate the command history. The default size is 12 commands, but this is configurable up to 50. The history can be persistent across launches; look in the preferences box.
  50.  
  51.  
  52.  
  53. Miscellaneous hidden features
  54.  
  55. All the standard editing commands are available, including undo, copy, paste, select all, page up, page down, and so on.  CLImax is also drag-happy and hopefully inline-input-aware. (Thanks, Marco!) 
  56.  
  57. When dragging text into the window, hold down the command key () to replace the entire contents of the field rather than inserting.
  58.  
  59. If CLImax is set to run as an invisible background app, hold down the control key when you double-click it to force it to launch as a normal foreground app. (Just in case you've forgotten your hotkey. :-)
  60.  
  61. CLImax will not let you run more than one copy of itself at once — and there are lots of good reasons for this — but if you need to override this feature, hold down the command key () while launching the second copy.
  62.  
  63.  
  64.  
  65. Scripting dictionary
  66.  
  67. CLImax's scripting dictionary is not well-fleshed out at this point in development, and object-based scripting won't be available until the next version, but here are the commands it understands so far:
  68.  
  69.    dictionary for anything
  70.        The parameter for this command can be either an alias, file specification, or string. If it's a string, CLImax
  71.        checks for the following in order:  full name of running process, four-char signature of running process,
  72.        four-char signature of some application on local disks, partial name of running process.  If a valid match
  73.        is found, CLImax launches your script editor and tells it to open the application's scripting dictionary.
  74.  
  75.     editor
  76.         Launches the script editor configured in the preferences box, for when CLImax just isn't powerful enough.
  77.  
  78.     do script string
  79.         Executes a script using CLImax's context and active scripting system. Possibly useful if you need to
  80.         put together a script on the fly.
  81.  
  82.     hide window
  83.     show window
  84.          These are pretty obvious.  :-)
  85.  
  86.     preferences
  87.          CLImax will activate and bring up its preferences box.  If executed while running as a daemon, it will
  88.          temporarily relaunch as a foreground app, display the dialog, and return to its normal state afterwards.
  89.  
  90.      about box
  91.          Just like choosing “About CLImax…” from the Apple menu when it's a foreground app.
  92.  
  93.      relaunch [as daemon/foreground app]
  94.          CLImax will quit and relaunch itself.  If you specify “as daemon”, CLImax turns into a faceless background
  95.          app (FBA) but still retains nearly all of its capabilities.  If you specify “as foreground app”, CLImax
  96.          launches as a normal application. (Well, almost normal, except its window still floats on top.)
  97.  
  98.      info for anything
  99.      dump anything
  100.      anything as hex dump
  101.      anything as text dump
  102.         info for returns a variety of information about its parameter, and is at least partially useful for doing
  103.         object specifier dumps.  dump simply changes the class of its parameter to DUMP and returns it, which
  104.         in most cases means that AppleScript will display the data as a hex dump.  text dump and hex dump are
  105.         special classes that most types can be coerced to, and return strings.
  106.  
  107.  
  108.  
  109.  
  110.